﻿/* ==============================================================================
*
*   Copyright (c) 2010, Pierre Favier
*   All rights reserved.
*
*   NTasking is free software: you can redistribute it and/or modify it
*   under the terms of the GNU General Public License as published by the
*   Free Software Foundation.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   -   Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*
*   -   Redistributions in binary form must reproduce the above
*       copyright notice, this list of conditions and the following
*       disclaimer in the documentation and/or other materials
*       provided with the distribution.
*
*   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
*   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
*   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
*   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
*   TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
*   ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
*   TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
*   THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*   SUCH DAMAGE.
*
* ============================================================================== */

using System;

namespace NTasking
{

    /// <summary>
    /// The <see cref="TaskingException"/> class is the parent class of all the <see cref="Exception"/> classes
    /// which can be thrown by the tasking runtime
    /// </summary>
    public abstract class TaskingException : Exception
    {
        /// <summary>
        /// Gets or sets the error code providing additional detail on the cause of the exception.
        /// </summary>
        /// <value>The error code.</value>
        public int ErrorCode { get; private set; }


        /// <summary>
        /// Initializes a new instance of the <see cref="TaskingException"/> class.
        /// </summary>
        /// <param name="errorCode">The error code providing additional detail on the cause of the exception.</param>
        /// <param name="message">The textual description of the cause of the exception.</param>
        protected TaskingException(int errorCode, string message)
            : base(message)
        {
            ErrorCode = errorCode;
        }
    }


    /// <summary>
    /// The <see cref="SyntaxError"/> exception is thrown whenever the runtime detects an error
    /// which in Ada would be detected by the compiler
    /// </summary>
    public class SyntaxError : TaskingException
    {

        /// <summary>
        /// Initializes a new instance of the <see cref="SyntaxError"/> class.
        /// </summary>
        /// <param name="errorCode">The error code providing additional detail on the cause of the exception.</param>
        /// <param name="message">The textual description of the cause of the exception.</param>
        internal SyntaxError(int errorCode, string message)
            : base(errorCode, message)
        {
        }

    }


    /// <summary>
    /// The <see cref="ProgramError"/> exception is thrown as per Ada standard
    /// </summary>
    public class ProgramError : TaskingException
    {

        /// <summary>
        /// Initializes a new instance of the <see cref="ProgramError"/> class.
        /// </summary>
        /// <param name="errorCode">The error code providing additional detail on the cause of the exception.</param>
        /// <param name="message">The textual description of the cause of the exception.</param>
        public ProgramError(int errorCode, string message)
            : base(errorCode, message)
        {
        }

    }


    /// <summary>
    /// The <see cref="TaskingError"/> exception is thrown as per Ada standard
    /// </summary>
    public class TaskingError : TaskingException
    {

        /// <summary>
        /// Initializes a new instance of the <see cref="TaskingError"/> class.
        /// </summary>
        /// <param name="errorCode">The error code providing additional detail on the cause of the exception.</param>
        /// <param name="message">The textual description of the cause of the exception.</param>
        internal TaskingError(int errorCode, string message)
            : base(errorCode, message)
        {
        }

    }


    /// <summary>
    /// The <see cref="RendezVousError"/> class is used to transport any exception thrown during a rendez-vous
    /// to the point where it will be rethrown without a lot of uninteresting stack trace
    /// </summary>
    internal class RendezVousError : Exception
    {

        /// <summary>
        /// Initializes a new instance of the <see cref="RendezVousError"/> class.
        /// </summary>
        /// <param name="innerException">The inner exception.</param>
        public RendezVousError(Exception innerException)
            : base("", innerException)
        {
        }

    }

}
